gh-71086: Document negative offset support in struct.pack_into() and unpack_from()#153650
Merged
serhiy-storchaka merged 1 commit intoJul 14, 2026
Merged
Conversation
…) and unpack_from() Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
serhiy-storchaka
added
docs
Documentation build overview
|
|
Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15. |
|
Sorry, @serhiy-storchaka, I could not cleanly backport this to |
|
GH-153699 is a backport of this pull request to the 3.15 branch. |
|
Sorry, @serhiy-storchaka, I could not cleanly backport this to |
bedevere-app
Bot
removed
the
needs backport to 3.15
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
struct.pack_into()andstruct.unpack_from()(and the correspondingStructmethods) accept a negative offset, counting from the end of thebuffer, but this was never documented.
Document it in
Doc/library/struct.rstand in the docstrings of all fourcallables. Also reword the module-level
unpack_from()docstring: the old"The buffer's size, minus offset, must be at least calcsize(format)" is
inaccurate for a negative offset, so it now reads "The buffer must contain at
least calcsize(format) bytes starting at offset".